home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / BBS-Archive / Util / Commodities / DOSPrefs22.lha / DOSPrefs.doc < prev    next >
Text File  |  1994-07-14  |  11KB  |  309 lines
  1. 1. About DOSPrefs
  2.  
  3. DOSPrefs is a small commodity with three functions:
  4.  
  5. 1. Control the "Wildstar"-flag of the Amiga OS 2.0+ dos.library.
  6.  
  7. 2. Control the "Noclick"-flags of the Amiga OS 2.0+ trackdisk.device.
  8.  
  9. 3. Provide an all new "Unixdirs"-feature.
  10.  
  11. These functions can be controlled when DOSPrefs is started by Tooltypes,
  12. or at runtime by Intuition(tm)-menus.
  13.  
  14. Furthermore, DOSPrefs is localized, using the locale.library* (requiring
  15. Workbench 2.1+) to adapt to your prefered language, and provides a context-
  16. sensitive help system with AmigaGuide(tm) (requiring amigaguide.library V34+).
  17. (Simply press "Help" !)
  18.  
  19. * currently, catalog and amigaguide help files for the following languages
  20. are included:
  21.  
  22. english (catalog built in)
  23. deutsch
  24. italiano
  25. dansk (catalog file only)
  26. français (catalog file only)
  27.  
  28. If you want, you can help me to provide support for additional languages.
  29. All you have to do is fill in the empty catalog source file DOSPrefs.ct and
  30. translate the helpfile catalogs/english/DOSPrefs.guide (note: you must not
  31. translate the @node names !!), and mail them to me (see below for my
  32. addresses). I will include them in the next release. DO NOT TRANSLATE THE
  33. CATALOG DESCRIPTOR FILE DOSPrefs.cd !!!
  34.  
  35. 2. Requirements
  36.  
  37. DOSPrefs requires at least Kickstart 2.04. To be more exact, the following
  38. libraries are needed:
  39.  
  40. exec.library V37
  41. dos.library V37
  42. commodities.library V37
  43. icon.library V37
  44. utility.library V37
  45. intuition.library V37
  46. gadtools.library V37
  47. graphics.library V37
  48. locale.library V38*
  49. amigaguide.library V34*
  50.  
  51. *: optional
  52.  
  53. 3. Installation
  54.  
  55. If you have the C= Installer program, simply double-click on the 
  56. Install-DOSPref Icon to start the installation. If you do not have the
  57. installer, this is what you have to do:
  58.  
  59. copy DOSPrefs SYS:WBStartup clone
  60. copy DOSPrefs.info SYS:WBStartup clone
  61. copy catalogs LOCALE:catalogs all clone ; if you have WB 2.1 +
  62. copy help HELP: all clone               ; if you have amigaguide
  63.  
  64. You may of course opt to install catalogs and helpfiles for only some of the
  65. provided languages.
  66.  
  67. NOTE: If you have AmigaGuide, DOSPrefs needs a HELP: assign. The standard
  68. for this assign is the directory locale:help. 
  69.  
  70. 4. Tooltypes
  71.  
  72. When DOSPrefs is started from the Workbench(tm), it evaluates the tooltypes
  73. of its icon; when it is started from the CLI, it evaluates the commandline
  74. arguments (the recognized Parameters are in both cases the same). The 
  75. parameters recognized by DOSPrefs are summarized in the following template:
  76.  
  77. CX_PRIORITY/N/K,CX_POPKEY/K,CX_POPUP/K,PUBSCREEN/K,WILDSTAR/K,UNIXDIRS/K,
  78. NOCLICK/K
  79.  
  80. CX_PRIORITY (default: 0): This is the priority for the commodities event
  81. handling mechanism.
  82.  
  83. CX_POPKEY (default: lalt d): This is the hotkey that causes DOSPrefs to
  84. show its interface. (By the way: starting DOSPrefs a second time will have
  85. the same effect as pressing the hot key; the first DOSPrefs will pop up and
  86. the second will terminate immediately.)
  87.  
  88. CX_POPUP (default: yes): This determines, if DOSPrefs is to show its
  89. interface on program startup.
  90.  
  91. PUBSCREEN (no default): This is the name of the public screen on which
  92. DOSPrefs is to open its interface. If this parameter is not specified or
  93. the given screen cannot be found, DOSPrefs opens its interface on the
  94. default public screen.
  95.  
  96. WILDSTAR (default: yes): This determines, if DOSPrefs is to set the
  97. wildstar flag of the dos.library on startup.
  98.  
  99. UNIXDIRS (default: yes): This determines, if DOSPrefs is to install the
  100. unixdirs-patch on startup.
  101.  
  102. NOCLICK (no default): This determines for which floppy drives DOSPrefs
  103. sets the noclick-flags on startup. You have to list the
  104. drives seperated by "|"s, e.g. "DF1:", "DF0:|DF1:|DF2:".
  105.  
  106. CAUTION: If an empty drive clicks even if you have set the noclick flag
  107. for this drive, unset the flag immediately. Your disk drive may be damaged
  108. otherwise.
  109.  
  110. 5. GUI
  111.  
  112. DOSPrefs has both menus and gadgets. The gadgets duplicate the functions of
  113. the "Settings" menu. 
  114.  
  115. DOSPrefs has the following Menu-structure (using the english language):
  116.  
  117.    Project              Settings
  118.      Save                 WildStar
  119.      About                UnixDirs
  120.      Enable               NoClick
  121.      Disable                DF0:
  122.      Hide                   DF1:
  123.      Quit                   DF2:
  124.                             DF3:
  125.                             
  126. 5.1 The Project Menu
  127.  
  128. "Save" saves the current settings in the DOSPrefs.info file.
  129.  
  130. "About" shows a nice, short copyright message. ;-)
  131.  
  132. "Enable" brings DOSPrefs to the active state. If it is already active,
  133. the "Enable" item is ghosted.
  134.  
  135. "Disable" brings DOSPrefs to the inactive state, if possible. If it is
  136. already inactive, the "Disable" item is ghosted.
  137. This operation may fail if the "unixdirs"-patch cannot be undone.
  138.  
  139. "Hide" hides the user interface of DOSPrefs. (Clicking on the
  140. closegadget has the same effect.) To make the interface visible again,
  141. press the hot key or use the commodities exchange program.
  142.  
  143. "Quit" terminates DOSPrefs, if possible.
  144. This may fail if the "unixdirs"-patch cannot be undone.
  145.  
  146. 5.2 The Settings Menu
  147.  
  148. 5.2.1 The WildStar Item
  149.  
  150. "WildStar" toggles the wildstar-flag of the dos.library. If the flag is set,
  151. "*" will be recognized as an abbreviation for "#?" in search patterns.
  152.  
  153. 5.2.2 The UnixDirs Item
  154.  
  155. "UnixDirs" enables the unixdirs-patch of the dos.library. What does this
  156. patch do ? It allows the use of the special directory names ".." and "."
  157. like under UNIX (thus the name of the function).
  158.  
  159. ".." represents the parent-directory of the current directory (like "/").
  160. So "../blabla" is identical to "/blabla", etc.
  161.  
  162. "." is the current directory. Thus you can say "copy ../blabla/*.c .".
  163.  
  164. NOTE: Due to the nature of library patches, it may not be possible to
  165. unpatch the dos.library if the patched functions are in use.
  166. DOSPrefs will detect this and put up a requester allowing you to try again 
  167. to unpatch the dos.library or to cancel the operation.
  168.  
  169. Here is an alphabetic list of the patched library funtions:
  170.  
  171. AssignLate
  172. AssignPath
  173. CreateDir
  174. DeleteFile
  175. GetDeviceProc
  176. LoadSeg
  177. Lock
  178. MakeLink
  179. NewLoadSeg
  180. Open
  181. Rename
  182. SetComment
  183. SetFileDate
  184. SetOwner*
  185. SetProtection
  186.  
  187. * V39 dos.library funtion
  188.  
  189. NOTE: In version 1.0, DOSPrefs patched some more functions. This was not a
  190. good idea - it caused weird problems when I improved the string conversion
  191. routine. 
  192.  
  193. 5.2.3 The NoClick SubMenu
  194.  
  195. The "NoClick" item has four subitems labeled "DF0:" to "DF3:", that allow you
  196. to set the noclick-flag individually for each of your disk drives. If a disk
  197. drive does not exist, its subitem is disabled.
  198.  
  199. CAUTION: If an empty drive clicks even if you have set the noclick flag
  200. for this drive, unset the flag immediately. Your disk drive may be damaged
  201. otherwise.
  202.  
  203. 6. Licence
  204.  
  205. DOSPrefs is Freeware. You may freely redistribute the complete, unchanged
  206. archive. You may not change any of the files or distribute an incomplete
  207. version of the archive. (Of course, you may change ToolTypes in the .info
  208. files. :-)) You may not add files to the archive, except ony .displayme -
  209. file with your mailbox-logo if - and only if - you have the archive freely
  210. available for download.
  211.  
  212. 7. Disclaimer & Warranty
  213.  
  214.      THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED
  215.      BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
  216.      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS
  217.      IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
  218.      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  219.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  220.      ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS
  221.      WITH YOU.  SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE
  222.      COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.  
  223.  
  224.        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  225.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  226.      REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU
  227.      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  228.      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  229.      THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
  230.      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  231.      PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER
  232.      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
  233.      OF THE POSSIBILITY OF SUCH DAMAGES.  
  234.  
  235. There is no warranty at all. Use at your own risk.
  236.  
  237. 8. Bug Reports
  238.  
  239. Report bugs & improvement suggestions to:
  240.  
  241. SnailMail:
  242.   Norbert Püschel
  243.   Am Turm 6
  244.   53572 Unkel
  245.   Germany
  246.  
  247. or
  248.  
  249. EMail:
  250.   nobbi@zaphod.rhein.de
  251.   pueschel@athene.informatik.uni-bonn.de 
  252.  
  253.   2:2453/30.14  (FidoNet)
  254.   21:100/50.14  (GerNet)
  255.   53:228/107.14 (BonNet)
  256.  
  257. 9. Credits
  258.  
  259. Thanks to the TrapDoor-Team for the disclaimer I shamelessly copied from
  260. them. ;-)
  261.  
  262. Thanks to Piergiorgio Ghezzo for writing italian catalog and guide files.
  263. Thanks to Klaus Alexander Seistrup for writing a danish catalog.
  264. Thanks to Florent Monteilhet for writing a french catalog.
  265.  
  266. 10. Version History
  267.  
  268.   1.0 (.07.93)
  269.   - first public release
  270.  
  271.   1.1 (.03.94)
  272.   - reduced number of patched functions. Some patches were superfluous,
  273.     some even potentially dangerous.
  274.   - improved string conversion routine. Now, the strings are no longer
  275.     patched "in place" but copied & converted onto the stack.
  276.  
  277.   1.2 (16.06.94)
  278.   - fixed bug in LoadSeg()-patch that caused programs with overlays to
  279.     crash. Thanks to Robert Reiswig for the bug report, shame to CBM for
  280.     the bad documentation.
  281.  
  282.   2.0 (05.07.94)
  283.   - improved GUI. Now has some checkbox gadgets in addition to menus.
  284.   - added a function to save the current settings in DOSPrefs.info
  285.   - improved patching mechanism. Now uses a jumptable; thus, DOSPrefs can
  286.     exit even if someone changed the patched vectors in dos.library.
  287.   - now detects if SetMan or SaferPatches is installed (skips library
  288.     vector change detection in this cases) (suggested by Gunther Nikl).
  289.   - moved the code that is not always needed (GUI, etc.) into an overlay.
  290.   - fixed string conversion function. Now processes names ending in .
  291.     correctly.
  292.   - improved help system. Now searches for guide files in your prefered
  293.     languages, defaulting to english if none are found.
  294.  
  295.   2.1 (11.07.94)
  296.   - included danish catalog file and italian catalog and guide files.
  297.   - inserted kludge in Open() and Lock() so that braindead programs
  298.     (uuencodex) that rely on condition codes being set after system call
  299.     work again (requested by Robert Reiswig).
  300.   - updated installer routine for additional catalogs.
  301.   - included DOSPrefs.cd file in distribution (requested by several people).
  302.     PLEASE, do NOT translate the .cd file but the .ct file !!! (and send it
  303.     to me).
  304.  
  305.   2.2 (14.07.94)
  306.   - included french catalog file.
  307.   - fixed (hopefully) cache clearing bug that could crash 68040 Amigas with 
  308.     copyback enabled (reported by Frank Kroll).
  309.